<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__sysclk__clk__pump__funcs.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Functions<div class="ingroups"><a class="el" href="group__group__sysclk.html">SysClk       (System Clock)</a> &raquo; <a class="el" href="group__group__sysclk__clk__pump.html">Pump Clock</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga14876f9c0e98b283defb6883fff0d906"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__pump__funcs.html#ga14876f9c0e98b283defb6883fff0d906">Cy_SysClk_ClkPumpSetSource</a> (<a class="el" href="group__group__sysclk__clk__pump__enums.html#gab816c6625c6a20701956a4831526cdda">cy_en_clkpump_in_sources_t</a> source)</td></tr>
<tr class="memdesc:ga14876f9c0e98b283defb6883fff0d906"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the source for the pump clock (clk_pump).  <a href="#ga14876f9c0e98b283defb6883fff0d906">More...</a><br /></td></tr>
<tr class="separator:ga14876f9c0e98b283defb6883fff0d906"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2428b1aa8d09aa27227185aef9d6945a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__sysclk__clk__pump__enums.html#gab816c6625c6a20701956a4831526cdda">cy_en_clkpump_in_sources_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__pump__funcs.html#ga2428b1aa8d09aa27227185aef9d6945a">Cy_SysClk_ClkPumpGetSource</a> (void)</td></tr>
<tr class="memdesc:ga2428b1aa8d09aa27227185aef9d6945a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the source for the pump clock (clk_pump).  <a href="#ga2428b1aa8d09aa27227185aef9d6945a">More...</a><br /></td></tr>
<tr class="separator:ga2428b1aa8d09aa27227185aef9d6945a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8d55fc79d235c3918ecb20b953afdb99"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__pump__funcs.html#ga8d55fc79d235c3918ecb20b953afdb99">Cy_SysClk_ClkPumpSetDivider</a> (<a class="el" href="group__group__sysclk__clk__pump__enums.html#ga8207bb47d9ecd521dc95375c1d46189e">cy_en_clkpump_divide_t</a> divider)</td></tr>
<tr class="memdesc:ga8d55fc79d235c3918ecb20b953afdb99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the divider of the pump clock (clk_pump).  <a href="#ga8d55fc79d235c3918ecb20b953afdb99">More...</a><br /></td></tr>
<tr class="separator:ga8d55fc79d235c3918ecb20b953afdb99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga252f8d2a95f5f381e03360c4b6b012ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__sysclk__clk__pump__enums.html#ga8207bb47d9ecd521dc95375c1d46189e">cy_en_clkpump_divide_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__pump__funcs.html#ga252f8d2a95f5f381e03360c4b6b012ef">Cy_SysClk_ClkPumpGetDivider</a> (void)</td></tr>
<tr class="memdesc:ga252f8d2a95f5f381e03360c4b6b012ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the divider value for the pump clock (clk_pump).  <a href="#ga252f8d2a95f5f381e03360c4b6b012ef">More...</a><br /></td></tr>
<tr class="separator:ga252f8d2a95f5f381e03360c4b6b012ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0249934e0fd1d05a25f7565a8c5b6cde"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__pump__funcs.html#ga0249934e0fd1d05a25f7565a8c5b6cde">Cy_SysClk_ClkPumpEnable</a> (void)</td></tr>
<tr class="memdesc:ga0249934e0fd1d05a25f7565a8c5b6cde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the pump clock (clk_pump).  <a href="#ga0249934e0fd1d05a25f7565a8c5b6cde">More...</a><br /></td></tr>
<tr class="separator:ga0249934e0fd1d05a25f7565a8c5b6cde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacd99d1c6e448c715e50e99462b6fe923"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__pump__funcs.html#gacd99d1c6e448c715e50e99462b6fe923">Cy_SysClk_ClkPumpIsEnabled</a> (void)</td></tr>
<tr class="memdesc:gacd99d1c6e448c715e50e99462b6fe923"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the Enabled/Disabled status of the ClkPump.  <a href="#gacd99d1c6e448c715e50e99462b6fe923">More...</a><br /></td></tr>
<tr class="separator:gacd99d1c6e448c715e50e99462b6fe923"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga70d97ab2865f7705619ce7369baee81f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__pump__funcs.html#ga70d97ab2865f7705619ce7369baee81f">Cy_SysClk_ClkPumpDisable</a> (void)</td></tr>
<tr class="memdesc:ga70d97ab2865f7705619ce7369baee81f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables the pump clock (clk_pump).  <a href="#ga70d97ab2865f7705619ce7369baee81f">More...</a><br /></td></tr>
<tr class="separator:ga70d97ab2865f7705619ce7369baee81f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3115e52203b8ac7c74a0bedc0083b925"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__pump__funcs.html#ga3115e52203b8ac7c74a0bedc0083b925">Cy_SysClk_ClkPumpGetFrequency</a> (void)</td></tr>
<tr class="memdesc:ga3115e52203b8ac7c74a0bedc0083b925"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the frequency of the pump clock (clk_pump).  <a href="#ga3115e52203b8ac7c74a0bedc0083b925">More...</a><br /></td></tr>
<tr class="separator:ga3115e52203b8ac7c74a0bedc0083b925"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga14876f9c0e98b283defb6883fff0d906"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga14876f9c0e98b283defb6883fff0d906">&#9670;&nbsp;</a></span>Cy_SysClk_ClkPumpSetSource()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysClk_ClkPumpSetSource </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__sysclk__clk__pump__enums.html#gab816c6625c6a20701956a4831526cdda">cy_en_clkpump_in_sources_t</a>&#160;</td>
          <td class="paramname"><em>source</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the source for the pump clock (clk_pump). </p>
<p>The pump clock can be used for the analog pumps in the CTBm block.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">source</td><td><a class="el" href="group__group__sysclk__clk__pump__enums.html#gab816c6625c6a20701956a4831526cdda">cy_en_clkpump_in_sources_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Do not change the source while the pump clock is enabled.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: The pump clock source needs to be updated to path 0 clock. */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span>(<a class="code" href="group__group__sysclk__clk__pump__enums.html#ggab816c6625c6a20701956a4831526cddaa0ddc1f655b605f0939f6ea9635de3378">CY_SYSCLK_PUMP_IN_CLKPATH0</a> != <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga2428b1aa8d09aa27227185aef9d6945a">Cy_SysClk_ClkPumpGetSource</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga14876f9c0e98b283defb6883fff0d906">Cy_SysClk_ClkPumpSetSource</a>(<a class="code" href="group__group__sysclk__clk__pump__enums.html#ggab816c6625c6a20701956a4831526cddaa0ddc1f655b605f0939f6ea9635de3378">CY_SYSCLK_PUMP_IN_CLKPATH0</a>);</div><div class="line">    }</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) and CAT1B devices. </dd></dl>

</div>
</div>
<a id="ga2428b1aa8d09aa27227185aef9d6945a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2428b1aa8d09aa27227185aef9d6945a">&#9670;&nbsp;</a></span>Cy_SysClk_ClkPumpGetSource()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__sysclk__clk__pump__enums.html#gab816c6625c6a20701956a4831526cdda">cy_en_clkpump_in_sources_t</a> Cy_SysClk_ClkPumpGetSource </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the source for the pump clock (clk_pump). </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__sysclk__clk__pump__enums.html#gab816c6625c6a20701956a4831526cdda">cy_en_clkpump_in_sources_t</a></dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: The pump clock source needs to be updated to path 0 clock. */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span>(<a class="code" href="group__group__sysclk__clk__pump__enums.html#ggab816c6625c6a20701956a4831526cddaa0ddc1f655b605f0939f6ea9635de3378">CY_SYSCLK_PUMP_IN_CLKPATH0</a> != <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga2428b1aa8d09aa27227185aef9d6945a">Cy_SysClk_ClkPumpGetSource</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga14876f9c0e98b283defb6883fff0d906">Cy_SysClk_ClkPumpSetSource</a>(<a class="code" href="group__group__sysclk__clk__pump__enums.html#ggab816c6625c6a20701956a4831526cddaa0ddc1f655b605f0939f6ea9635de3378">CY_SYSCLK_PUMP_IN_CLKPATH0</a>);</div><div class="line">    }</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) and CAT1B devices. </dd></dl>

</div>
</div>
<a id="ga8d55fc79d235c3918ecb20b953afdb99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8d55fc79d235c3918ecb20b953afdb99">&#9670;&nbsp;</a></span>Cy_SysClk_ClkPumpSetDivider()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysClk_ClkPumpSetDivider </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__sysclk__clk__pump__enums.html#ga8207bb47d9ecd521dc95375c1d46189e">cy_en_clkpump_divide_t</a>&#160;</td>
          <td class="paramname"><em>divider</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the divider of the pump clock (clk_pump). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">divider</td><td><a class="el" href="group__group__sysclk__clk__pump__enums.html#ga8207bb47d9ecd521dc95375c1d46189e">cy_en_clkpump_divide_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Do not change the divider value while the pump clock is enabled.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: The pump clock divider needs to be updated to 4. */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span>(<a class="code" href="group__group__sysclk__clk__pump__enums.html#gga8207bb47d9ecd521dc95375c1d46189eaadac3fd4b4235df3814fdf3c8468a273">CY_SYSCLK_PUMP_DIV_4</a> != <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga252f8d2a95f5f381e03360c4b6b012ef">Cy_SysClk_ClkPumpGetDivider</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga8d55fc79d235c3918ecb20b953afdb99">Cy_SysClk_ClkPumpSetDivider</a>(<a class="code" href="group__group__sysclk__clk__pump__enums.html#gga8207bb47d9ecd521dc95375c1d46189eaadac3fd4b4235df3814fdf3c8468a273">CY_SYSCLK_PUMP_DIV_4</a>);</div><div class="line">    }</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) and CAT1B devices. </dd></dl>

</div>
</div>
<a id="ga252f8d2a95f5f381e03360c4b6b012ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga252f8d2a95f5f381e03360c4b6b012ef">&#9670;&nbsp;</a></span>Cy_SysClk_ClkPumpGetDivider()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__sysclk__clk__pump__enums.html#ga8207bb47d9ecd521dc95375c1d46189e">cy_en_clkpump_divide_t</a> Cy_SysClk_ClkPumpGetDivider </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the divider value for the pump clock (clk_pump). </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__sysclk__clk__pump__enums.html#ga8207bb47d9ecd521dc95375c1d46189e">cy_en_clkpump_divide_t</a></dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: The pump clock divider needs to be updated to 4. */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span>(<a class="code" href="group__group__sysclk__clk__pump__enums.html#gga8207bb47d9ecd521dc95375c1d46189eaadac3fd4b4235df3814fdf3c8468a273">CY_SYSCLK_PUMP_DIV_4</a> != <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga252f8d2a95f5f381e03360c4b6b012ef">Cy_SysClk_ClkPumpGetDivider</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga8d55fc79d235c3918ecb20b953afdb99">Cy_SysClk_ClkPumpSetDivider</a>(<a class="code" href="group__group__sysclk__clk__pump__enums.html#gga8207bb47d9ecd521dc95375c1d46189eaadac3fd4b4235df3814fdf3c8468a273">CY_SYSCLK_PUMP_DIV_4</a>);</div><div class="line">    }</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) and CAT1B devices. </dd></dl>

</div>
</div>
<a id="ga0249934e0fd1d05a25f7565a8c5b6cde"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0249934e0fd1d05a25f7565a8c5b6cde">&#9670;&nbsp;</a></span>Cy_SysClk_ClkPumpEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysClk_ClkPumpEnable </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables the pump clock (clk_pump). </p>
<p>The pump clock can be used for the analog pumps in the CTBm block.</p>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: The Pump clock must be sourced from the Path 2 clock. The</span></div><div class="line"><span class="comment">                 frequency of the pump clock must be 1/16 of Path 2 clock. */</span></div><div class="line"></div><div class="line">    <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga14876f9c0e98b283defb6883fff0d906">Cy_SysClk_ClkPumpSetSource</a>(<a class="code" href="group__group__sysclk__clk__pump__enums.html#ggab816c6625c6a20701956a4831526cddaa987e09d7fa8a1717c9b804606edff91a">CY_SYSCLK_PUMP_IN_CLKPATH2</a>);</div><div class="line">    <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga8d55fc79d235c3918ecb20b953afdb99">Cy_SysClk_ClkPumpSetDivider</a>(<a class="code" href="group__group__sysclk__clk__pump__enums.html#gga8207bb47d9ecd521dc95375c1d46189ea928a528d707915099495847a937625e8">CY_SYSCLK_PUMP_DIV_16</a>);</div><div class="line">    <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga0249934e0fd1d05a25f7565a8c5b6cde">Cy_SysClk_ClkPumpEnable</a>();</div><div class="line">    <span class="comment">/* Use the pump clock as the source for CTB(m) blocks. */</span></div><div class="line">    <span class="comment">/* In case if there is a need to get the pump clock frequency */</span></div><div class="line">    uint32_t pumpClkFreq = <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga3115e52203b8ac7c74a0bedc0083b925">Cy_SysClk_ClkPumpGetFrequency</a>();</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) and CAT1B devices. </dd></dl>

</div>
</div>
<a id="gacd99d1c6e448c715e50e99462b6fe923"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacd99d1c6e448c715e50e99462b6fe923">&#9670;&nbsp;</a></span>Cy_SysClk_ClkPumpIsEnabled()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Cy_SysClk_ClkPumpIsEnabled </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the Enabled/Disabled status of the ClkPump. </p>
<dl class="section return"><dt>Returns</dt><dd>Boolean status of ClkPump: true - Enabled, false - Disabled.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Pump clock is no longer required and needs to be disabled.</span></div><div class="line"><span class="comment">                 All peripherals clocked using this source are disabled. */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__sysclk__clk__pump__funcs.html#gacd99d1c6e448c715e50e99462b6fe923">Cy_SysClk_ClkPumpIsEnabled</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga70d97ab2865f7705619ce7369baee81f">Cy_SysClk_ClkPumpDisable</a>();</div><div class="line">    }</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) and CAT1B devices. </dd></dl>

</div>
</div>
<a id="ga70d97ab2865f7705619ce7369baee81f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga70d97ab2865f7705619ce7369baee81f">&#9670;&nbsp;</a></span>Cy_SysClk_ClkPumpDisable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysClk_ClkPumpDisable </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disables the pump clock (clk_pump). </p>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Pump clock is no longer required and needs to be disabled.</span></div><div class="line"><span class="comment">                 All peripherals clocked using this source are disabled. */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__sysclk__clk__pump__funcs.html#gacd99d1c6e448c715e50e99462b6fe923">Cy_SysClk_ClkPumpIsEnabled</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga70d97ab2865f7705619ce7369baee81f">Cy_SysClk_ClkPumpDisable</a>();</div><div class="line">    }</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) and CAT1B devices. </dd></dl>

</div>
</div>
<a id="ga3115e52203b8ac7c74a0bedc0083b925"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3115e52203b8ac7c74a0bedc0083b925">&#9670;&nbsp;</a></span>Cy_SysClk_ClkPumpGetFrequency()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t Cy_SysClk_ClkPumpGetFrequency </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the frequency of the pump clock (clk_pump). </p>
<dl class="section note"><dt>Note</dt><dd>If the the pump clock is not enabled - a zero frequency is reported.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: The Pump clock must be sourced from the Path 2 clock. The</span></div><div class="line"><span class="comment">                 frequency of the pump clock must be 1/16 of Path 2 clock. */</span></div><div class="line"></div><div class="line">    <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga14876f9c0e98b283defb6883fff0d906">Cy_SysClk_ClkPumpSetSource</a>(<a class="code" href="group__group__sysclk__clk__pump__enums.html#ggab816c6625c6a20701956a4831526cddaa987e09d7fa8a1717c9b804606edff91a">CY_SYSCLK_PUMP_IN_CLKPATH2</a>);</div><div class="line">    <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga8d55fc79d235c3918ecb20b953afdb99">Cy_SysClk_ClkPumpSetDivider</a>(<a class="code" href="group__group__sysclk__clk__pump__enums.html#gga8207bb47d9ecd521dc95375c1d46189ea928a528d707915099495847a937625e8">CY_SYSCLK_PUMP_DIV_16</a>);</div><div class="line">    <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga0249934e0fd1d05a25f7565a8c5b6cde">Cy_SysClk_ClkPumpEnable</a>();</div><div class="line">    <span class="comment">/* Use the pump clock as the source for CTB(m) blocks. */</span></div><div class="line">    <span class="comment">/* In case if there is a need to get the pump clock frequency */</span></div><div class="line">    uint32_t pumpClkFreq = <a class="code" href="group__group__sysclk__clk__pump__funcs.html#ga3115e52203b8ac7c74a0bedc0083b925">Cy_SysClk_ClkPumpGetFrequency</a>();</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) and CAT1B devices. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
